// Copyright (C) Vamsi.  2017-18 All rights reserved.
// Source code based on yans-wifi-helper.h of NS3

/*
 * Copyright (c) 2008 INRIA
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */

#ifndef MATLAB_WIFI_HELPER_H
#define MATLAB_WIFI_HELPER_H

#include "ns3/wifi-helper.h"
#include "ml-wifi-channel.h"
#include "ns3/core-module.h"
#include "ns3/wifi-module.h"

using namespace ns3;

/**
 * \brief manage and create wifi channel objects for the MATLAB model.
 *
 * The intent of this class is to make it easy to create a channel object
 * which implements the MATLAB channel model.
 */
class MatlabWifiChannelHelper
{
	public:
		/**
		 * Create a channel helper without any parameter set. The user must set
		 * them all to be able to call Create later.
		 */
		MatlabWifiChannelHelper ();

		/**
		 * Create a channel helper in a default working state. By default, we create
		 * a channel model with a propagation delay equal to a constant, the speed of light,
		 * and a propagation loss based on a log distance model with a reference loss of 46.6777 dB
		 * at reference distance of 1m.
		 * \returns MatlabWifiChannelHelper
		 */
		static MatlabWifiChannelHelper Default (void);

		/**
		 * \param name the name of the model to add
		 * \param n0 the name of the attribute to set
		 * \param v0 the value of the attribute to set
		 * \param n1 the name of the attribute to set
		 * \param v1 the value of the attribute to set
		 * \param n2 the name of the attribute to set
		 * \param v2 the value of the attribute to set
		 * \param n3 the name of the attribute to set
		 * \param v3 the value of the attribute to set
		 * \param n4 the name of the attribute to set
		 * \param v4 the value of the attribute to set
		 * \param n5 the name of the attribute to set
		 * \param v5 the value of the attribute to set
		 * \param n6 the name of the attribute to set
		 * \param v6 the value of the attribute to set
		 * \param n7 the name of the attribute to set
		 * \param v7 the value of the attribute to set
		 *
		 * Add a propagation loss model to the set of currently-configured loss models.
		 * This method is additive to allow you to construct complex propagation loss models
		 * such as a log distance + jakes model, etc.
		 *
		 * The order in which PropagationLossModels are added may be significant. Some
		 * propagation models are dependent of the "txPower" (eg. Nakagami model), and
		 * are therefore not commutative. The final receive power (excluding receiver
		 * gains) are calculated in the order the models are added.
		 */
		void AddPropagationLoss (std::string name,
				std::string n0 = "", const AttributeValue &v0 = EmptyAttributeValue (),
				std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
				std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
				std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
				std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
				std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
				std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
				std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue ());
		/**
		 * \param name the name of the model to set
		 * \param n0 the name of the attribute to set
		 * \param v0 the value of the attribute to set
		 * \param n1 the name of the attribute to set
		 * \param v1 the value of the attribute to set
		 * \param n2 the name of the attribute to set
		 * \param v2 the value of the attribute to set
		 * \param n3 the name of the attribute to set
		 * \param v3 the value of the attribute to set
		 * \param n4 the name of the attribute to set
		 * \param v4 the value of the attribute to set
		 * \param n5 the name of the attribute to set
		 * \param v5 the value of the attribute to set
		 * \param n6 the name of the attribute to set
		 * \param v6 the value of the attribute to set
		 * \param n7 the name of the attribute to set
		 * \param v7 the value of the attribute to set
		 *
		 * Configure a propagation delay for this channel.
		 */
		void SetPropagationDelay (std::string name,
				std::string n0 = "", const AttributeValue &v0 = EmptyAttributeValue (),
				std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
				std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
				std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
				std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
				std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
				std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
				std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue ());

		/**
		 * \returns a new channel
		 *
		 * Create a channel based on the configuration parameters set previously.
		 */
		Ptr<MatlabWifiChannel> Create (void) const;

		/**
		 * Assign a fixed random variable stream number to the random variables
		 * used by the channel.  Typically this corresponds to random variables
		 * used in the propagation loss models.  Return the number of streams
		 * (possibly zero) that have been assigned.
		 *
		 * \param c NetDeviceContainer of the set of net devices for which the
		 *          WifiNetDevice should be modified to use fixed streams
		 * \param stream first stream index to use
		 *
		 * \return the number of stream indices assigned by this helper
		 */
		int64_t AssignStreams (Ptr<MatlabWifiChannel> c, int64_t stream);

		MATLAB_WST_CALLBACK matlabWSTCallback;
		void RegisterWSTCallback(MATLAB_WST_CALLBACK ptr);


	private:
		std::vector<ObjectFactory> m_propagationLoss; ///< vector of propagation loss models
		ObjectFactory m_propagationDelay; ///< propagation delay model
};


/**
 * \brief Make it easy to create and manage PHY objects for the MATLAB model.
 *
 * The Pcap and ascii traces generated by the EnableAscii and EnablePcap methods defined
 * in this class correspond to PHY-level traces and come to us via WifiPhyHelper
 *
 */
class MatlabWifiPhyHelper : public WifiPhyHelper
{
	public:
		/**
		 * Create a phy helper without any parameter set. The user must set
		 * them all to be able to call Install later.
		 */
		MatlabWifiPhyHelper ();

		/**
		 * Create a phy helper in a default working state.
		 * \returns a default MatlabWifiPhyHelper
		 */
		static MatlabWifiPhyHelper Default (void);

		/**
		 * \param channel the channel to associate to this helper
		 *
		 * Every PHY created by a call to Install is associated to this channel.
		 */
		void SetChannel (Ptr<MatlabWifiChannel> channel);
		/**
		 * \param channelName The name of the channel to associate to this helper
		 *
		 * Every PHY created by a call to Install is associated to this channel.
		 */
		void SetChannel (std::string channelName);

	private:
		/**
		 * \param node the node on which we wish to create a wifi PHY
		 * \param device the device within which this PHY will be created
		 * \returns a newly-created PHY object.
		 *
		 * This method implements the pure virtual method defined in \ref ns3::WifiPhyHelper.
		 */
		virtual Ptr<WifiPhy> Create (Ptr<Node> node, Ptr<NetDevice> device) const;

		Ptr<MatlabWifiChannel> m_channel; ///< MATLAB wifi channel
};

#endif /* MATLAB_WIFI_HELPER_H */
